JxBrowser/com.teamdev.jxbrowser.engine/[jvm]EngineOptions/Builder

Builder

A builder class to construct engine options.

Builders are created by invoking newBuilder. Each of the setter methods modifies the state of the builder and returns the same instance. Builders are not thread-safe and should not be used concurrently from multiple threads without external synchronization.

Functions

open fun addScheme(scheme: Scheme, callback: InterceptUrlRequestCallback): EngineOptions.Builder

Associates the given URL scheme with the callback, so that all URL requests with the given scheme will be intercepted before they are sent out.

open fun addSwitch(commandLineSwitch: String): EngineOptions.Builder

Adds the switch to the list of the switches that will be passed to the Chromium process.

allowFileAccessFromFiles

open fun allowFileAccessFromFiles(): EngineOptions.Builder

Allows file access from files for the Engine instance.

open fun build(): EngineOptions

Creates an EngineOptions instance.

open fun chromiumDir(chromiumDir: Path): EngineOptions.Builder

Sets the absolute path to the directory where Chromium binaries are located.

disableChromiumTraffic

open fun disableChromiumTraffic(): EngineOptions.Builder

Disables Chromium services that cause additional traffic, such as Google Cloud Messaging, Translate Ranker, Extensions Updater, Safe Browsing, etc.

disableDnsQuickCheck

open fun disableDnsQuickCheck(): EngineOptions.Builder

Disables DNS quick check.

open fun disableGpu(): EngineOptions.Builder

Disables GPU rendering for the Engine instance.

open fun disableSandbox(): EngineOptions.Builder

Disables the sandbox for the Engine instance.

disableTouchMenu

open fun disableTouchMenu(): EngineOptions.Builder

Disables the touch popup menu for the Engine instance.

disableWebSecurity

open fun disableWebSecurity(): EngineOptions.Builder

Disables the same-origin policy for the Engine instance.

open fun diskCacheSize(diskCacheSize: Long): EngineOptions.Builder

Sets the disk cache size, in bytes.

open fun enableAutoplay(): EngineOptions.Builder

Allows automatically starting video and audio playbacks.

enableIncognito

open fun enableIncognito(): EngineOptions.Builder

Enables the incognito mode for the default profile of the Engine instance.

enableMediaRouting

open fun enableMediaRouting(): EngineOptions.Builder

Enables media routing for the Engine instance.

enableProprietaryFeature

open fun enableProprietaryFeature(feature: ProprietaryFeature): EngineOptions.Builder

Enables the given proprietary feature for the Engine instance.

open fun googleApiKey(googleApiKey: String): EngineOptions.Builder

Sets the Google API key.

googleDefaultClientId

open fun googleDefaultClientId(googleDefaultClientId: String): EngineOptions.Builder

Sets the Google client ID.

googleDefaultClientSecret

open fun googleDefaultClientSecret(googleDefaultClientSecret: String): EngineOptions.Builder

Sets the Google client secret.

open fun language(language: Language): EngineOptions.Builder

Sets the Chromium language that is used on the default error pages and the message dialogs.

open fun licenseKey(licenseKey: String): EngineOptions.Builder

Sets the licence key required to perform operations with the engine.

open fun passwordStore(passwordStore: PasswordStore): EngineOptions.Builder

Sets the password store type that specifies which storage backend to use to encrypt cookies on Linux.

remoteDebuggingPort

open fun remoteDebuggingPort(remoteDebuggingPort: Int): EngineOptions.Builder

Sets the remote debugging port.

rendererHangTimeout

open fun rendererHangTimeout(timeout: Duration): EngineOptions.Builder

Sets how long the renderer can be unresponsive before it is considered hung.

treatInsecureOriginAsSecure

open fun treatInsecureOriginAsSecure(origins: Array<String>): EngineOptions.Builder

Adds the given origins to the white list.

open fun userAgent(userAgent: String): EngineOptions.Builder

Sets the custom user agent string that is used to override the default user agent for the Engine.

open fun userDataDir(userDataDir: Path): EngineOptions.Builder

Sets the absolute path to the directory where the user data is stored.